/*
 *  DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 *  Copyright (c) [2020] Payara Foundation and/or its affiliates. All rights reserved.
 *
 *  The contents of this file are subject to the terms of either the GNU
 *  General Public License Version 2 only ("GPL") or the Common Development
 *  and Distribution License("CDDL") (collectively, the "License").  You
 *  may not use this file except in compliance with the License.  You can
 *  obtain a copy of the License at
 *  https://github.com/payara/Payara/blob/main/LICENSE.txt
 *  See the License for the specific
 *  language governing permissions and limitations under the License.
 *
 *  When distributing the software, include this License Header Notice in each
 *  file and include the License file at legal/OPEN-SOURCE-LICENSE.txt.
 *
 *  GPL Classpath Exception:
 *  The Payara Foundation designates this particular file as subject to the "Classpath"
 *  exception as provided by the Payara Foundation in the GPL Version 2 section of the License
 *  file that accompanied this code.
 *
 *  Modifications:
 *  If applicable, add the following below the License Header, with the fields
 *  enclosed by brackets [] replaced by your own identifying information:
 *  "Portions Copyright [year] [name of copyright owner]"
 *
 *  Contributor(s):
 *  If you wish your version of this file to be governed by only the CDDL or
 *  only the GPL Version 2, indicate your decision by adding "[Contributor]
 *  elects to include this software in this distribution under the [CDDL or GPL
 *  Version 2] license."  If you don't indicate a single choice of license, a
 *  recipient has the option to distribute your version of this file under
 *  either the CDDL, the GPL Version 2 or to extend the choice of license to
 *  its licensees as provided above.  However, if you add GPL Version 2 code
 *  and therefore, elected the GPL Version 2 license, then the option applies
 *  only if the new code is made subject to such option by the copyright
 *  holder.
 */
package org.glassfish.internal.api;

import java.util.stream.Stream;

/**
 * Wraps an object with a proxy that sets Payara context around
 * every method call. This is useful for listeners, callbacks,
 * and other objects that run from another thread that may not have
 * Payara context initialized.
 *
 * This was create primarily to facilitate integration with Hazelcast,
 * which has listeners that do not capture Payara context.
 *
 * Example:
 * @Inject Contextualizer contextualizer;
 * @Inject MyListener myListener;
 *
 * // runs myListener.listen() method in a separate thread,
 * // with context captured from current thread
 * new Thread(contextualizer.contextualize(() -> myListener.listen(), Runnable.class));
 *
 * @author lprimak
 */
public interface Contextualizer {
    /**
     * Wraps an object in a proxy that preserves Payara context
     *
     * @param <T> object type to proxy and contextualize
     * @param object object instance to proxy and contextualize
     * @param intf Interface that is used to proxy the object
     * @return proxied object
     */
    <T> T contextualize(T object, Class<T> intf);

    /**
     * Wraps an object in a proxy that preserves Payara context
     *
     * @param <T>
     * @param object
     * @param context
     * @param intf
     * @return proxied object
     */
    <T> T contextualize(T object, ContextProducer.Instance context, Class<T> intf);

    /**
     * Wraps an object in a proxy that preserves Payara context
     *
     * @param <T>
     * @param object
     * @param context
     * @param interfaces
     * @return proxied object
     */
    <T> T contextualize(T object, ContextProducer.Instance context, Stream<Class<?>> interfaces);
}
